home *** CD-ROM | disk | FTP | other *** search
/ Mac Magazin/MacEasy 25 / Mac Magazin and MacEasy Magazine CD - Issue 25.iso / Grafik & Text / BibTeX / BibTeX.ReadMe < prev   
Text File  |  1996-06-04  |  8KB  |  174 lines
  1. # ###################################################################
  2. # 
  3. #  FILE: "BibTeX.ReadMe"
  4. #                                    created: 4/2/96 {6:50:21 pm} 
  5. #                                last update: 4/6/96 {10:28:25 am} 
  6. #  Author: Vince Darley
  7. #  E-mail: <mailto:vince@das.harvard.edu>
  8. #    mail: Division of Applied Sciences, Harvard University
  9. #          Oxford Street, Cambridge MA 02138, USA
  10. #     www: <http://www.fas.harvard.edu/~darley/>
  11. #  
  12. #  Mac port copyright (C) 1996 Vince Darley.
  13. #
  14. #  Freely distributable, please report bugs (and fixes) to
  15. #  the author.
  16. #
  17. # ###################################################################
  18.  
  19. This is BibTeX (fat)
  20. ====================
  21.  
  22. BibTeX is the bibliography handling tool related to the TeX/LaTeX 
  23. typesetting system (available on almost all conceivable OS platforms).  
  24. When a document is typeset with LaTeX, an auxiliary file (with extension 
  25. '.aux') is generated.  This auxiliary file contains, amongst other things, 
  26. a list of references (to books, articles, research reports, web-url's,...)  
  27. cited in the original document.  BibTeX takes this list, together with the 
  28. name of a style file (extension '.bst') and a list of bibliography 
  29. databases (extension '.bib') which are also given in the auxiliary file, 
  30. and produces a wonderfully formatted list of references which the LaTeX 
  31. system subsequently (and automatically) appends to your typeset document.
  32.  
  33. Hence BibTeX is really not at all useful without TeX/LaTeX (there are 
  34. several freeware/shareware/commercial versions for the MacOS: OzTeX, 
  35. CMacTeX, DirecTeX Pro, Textures).  In fact this version of BibTeX is now 
  36. distributed with OzTeX 2.0.  It is useful to have a good text editor which 
  37. knows about the particular format of LaTeX documents: on the Mac, the 
  38. editor Alpha is indispensible in this regard, both for editing and for its 
  39. apple-event communication with the various parts of a LaTeX system.
  40.  
  41. For those who think this sounds a bit too complicated, the benefits in 
  42. terms of quality of output (both textual and mathematical) and automatic 
  43. generation of all manner of numbering schemes (figures, equations, 
  44. sections), and document parts (table of contents, index, bibliography), 
  45. together with cross-platform availability, mean that many people consider 
  46. it the _best_ current system for producing quality documents.
  47.  
  48. Here are some links for further information:
  49.  
  50. •    Mathematical relevance: <http://e-math.ams.org/>
  51. •    General TeX documentation: <http://www.cl.cam.ac.uk/TeXdoc/TeXdocs.html>
  52. •    Archive of LaTeX documenation: <http://www.loria.fr/tex/english/index.html>
  53. •    More LaTeX links: <http://molscat.giss.nasa.gov/LaTeX/externals.html>
  54. •    The editor 'Alpha': <http://www.cs.umd.edu/~keleher/alpha.html>
  55. •    Various TeX-related links: <http://www.bluesky.com/TeXlinks>
  56. •    CMacTeX: <http://www.math.tamu.edu/~tkiffe/cmactex.html>
  57. •    OzTeX: <http://198.207.242.3/authors/akt/oztex.html>
  58. •    Textures: <http://www.bluesky.com/>
  59. •    Archive of all TeX related material: <http://jasper.ora.com/ctan.html>
  60.  
  61. ========================================================================
  62.  
  63. BibTeX version 1.06
  64.  
  65. It has no known bugs, however, use at your own risk; there is no 
  66. warranty....  The only known crashes seem to be due to low memory 
  67. conditions, so I now set the application's partition to 400k by default.  I 
  68. think it should work with 365k on 680x0 machines, and 300k on PPC machines,  
  69. so you could lower the application's partition size.
  70.  
  71. Features: 
  72.  
  73. •    it works;
  74. •    switchable between 'bib' and 'small' modes.  The 'big' mode increases
  75.     the size of biobiography resources such as the number of strings allowed.
  76. •    copes with both Unix and Mac standard eol characters.
  77. •    reasonably fast (the original bibtex code is sadly not up to scratch
  78.     as far as efficieny goes);
  79. •    support high-level apple events etc. so you can drag a '.aux' file (or 
  80.     several) onto it for processing, or send it an odoc event from Alpha...
  81. •    friendly to other apps (actually calls WaitNextEvent);
  82. •    Fat binary; also runs on 68k (but with less testing);
  83. •    Source code available;
  84. •    Common search path for both .bst and .bib files, although you
  85.     can of course keep them in separate directories if you like.
  86.  
  87. This version of BibTeX is totally free.
  88.  
  89. Recent changes:
  90.  
  91. 1.06    Now copes with extended character set 'üöé...'.  Not all TeX
  92.         implementations allow them, but if you pass one to BibTeX, it
  93.         will happily output it, assuming your version of TeX can cope.
  94.         Changed name of log window.
  95. 1.05    Recompiled with CW9, updated to take account of Powerplant
  96.         changes.  Cosmetic change when selecting 'go' to re-run
  97.         a file - the window is now cleared first.
  98. 1.04    Minor (non-fatal) bug fixes --- all files properly closed and 
  99.         flushed after a bibtex error, file eof's set correctly for .bbl 
  100.         and .blg files.
  101.         Thanks for the bug reports!
  102. 1.03    Minor changes --- it now gives a message 'BibTeX run complete.'
  103.         in the log window, rather than just finishing.  Documentation
  104.         update.  I've fixed the FREF/BNDL problems, so drag'n'drop
  105.         really should work now ;-)
  106. 1.02    Switchable between Big and Small.  Uses new memory allocation
  107.         scheme from Rick, so temporary memory is used rather than the
  108.         system heap.  This means the application's given partition can
  109.         be much smaller (300k works for me). Added fref 'TEXT' resource
  110.         which was missing previously (so drag and drop will work under
  111.         all circumstances now).
  112. 1.01    Copes with Unix as well as Mac EOL characters
  113. 1.0        Original; soon to be distributed with OzTeX 2.0
  114.  
  115. ========================================================================
  116.  
  117. The Editor 'Alpha'
  118.  
  119. Download a new version of Alpha if you're using < 6.2; the new versions
  120. contain an enhanced LaTeX mode which knows how to interact with BibTeX.
  121.  
  122. ========================================================================
  123.  
  124. Technical Stuff:
  125.  
  126. To Do:
  127.  
  128. •    Let paths be set in a dialog box
  129. •    When there isn't enough memory a type 11 error is the usual message
  130.     --- a meaningful message should be given
  131. •    Work out more accurately how much memory the application really needs
  132.     (it seems to crash rather than put up nice Powerplant messages
  133.     in a low memory situation).
  134. •    Write to .blg and .bbl files asynchronously --- I've tried to do this,
  135.     but my code fails (crash!). Look in fileio.cp:PutC() if you think you
  136.     can fix this.
  137.  
  138. Any offers for help or suggestions for improvements much appreciated --- in 
  139. particular if someone wants to get to work on the to-do's, that'd be great.
  140.  
  141. ------
  142.  
  143. Sources:
  144.  
  145. Based on the C code of the original MacBibTeX (0.99c) which I grabbed from
  146. CTAN, and code generously donated by Rick Zaccone from his 'Makeindex'.
  147. Icon adapted from one I grabbed off a folder from some collection on the net.
  148.  
  149. ------
  150.  
  151. Compilation (with CodeWarrior 9):
  152.  
  153. Obtain the library 'MoreFiles' (preferably version 1.4.1/2). It should be 
  154. available from the info-mac archives.
  155.  
  156. •    Open the source code folder
  157. •    Compile BibTeX68k.µ
  158. •    Compile BibTeXPPC.µ
  159.  
  160. Move the resulting application "BibTeX" up one level so it can find 'BibTeX 
  161. inputs'.  You may need to adjust the memory allocation (with Get Info), but 
  162. beyond that you're set.
  163.  
  164. -----
  165.  
  166. Personaliation:
  167.  
  168. You can edit a string resource with ResEdit to specify your own search 
  169. path.  To do this open the app with ResEdit and look at the STR# resource 
  170. called "Path".  You can add entries which look like the final one: a 
  171. complete path specification preceded by '2'.  If you prefer, '0:' indicates 
  172. a path relative to the .aux file, and '1:' relative to the BibTeX 
  173. application.
  174.